home *** CD-ROM | disk | FTP | other *** search
- /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
- /* ***** BEGIN LICENSE BLOCK *****
- * Version: MPL 1.1/GPL 2.0/LGPL 2.1
- *
- * The contents of this file are subject to the Mozilla Public License Version
- * 1.1 (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- * http://www.mozilla.org/MPL/
- *
- * Software distributed under the License is distributed on an "AS IS" basis,
- * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
- * for the specific language governing rights and limitations under the
- * License.
- *
- * The Original Code is Mozilla FastLoad code.
- *
- * The Initial Developer of the Original Code is
- * Netscape Communications Corporation.
- * Portions created by the Initial Developer are Copyright (C) 2001
- * the Initial Developer. All Rights Reserved.
- *
- * Contributor(s):
- * Brendan Eich <brendan@mozilla.org> (original author)
- *
- * Alternatively, the contents of this file may be used under the terms of
- * either of the GNU General Public License Version 2 or later (the "GPL"),
- * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
- * in which case the provisions of the GPL or the LGPL are applicable instead
- * of those above. If you wish to allow use of your version of this file only
- * under the terms of either the GPL or the LGPL, and not to allow others to
- * use your version of this file under the terms of the MPL, indicate your
- * decision by deleting the provisions above and replace them with the notice
- * and other provisions required by the GPL or the LGPL. If you do not delete
- * the provisions above, a recipient may use your version of this file under
- * the terms of any one of the MPL, the GPL or the LGPL.
- *
- * ***** END LICENSE BLOCK ***** */
-
- #include "nsIBinaryInputStream.idl"
- #include "nsrootidl.idl"
-
- /**
- * @see nsIObjectOutputStream
- * @see nsIBinaryInputStream
- */
-
- [scriptable, uuid(6c248606-4eae-46fa-9df0-ba58502368eb)]
- interface nsIObjectInputStream : nsIBinaryInputStream
- {
- /**
- * Read an object from this stream to satisfy a strong or weak reference
- * to one of its interfaces. If the interface was not along the primary
- * inheritance chain ending in the "root" or XPCOM-identity nsISupports,
- * readObject will QueryInterface from the deserialized object root to the
- * correct interface, which was specified when the object was serialized.
- *
- * @see nsIObjectOutputStream
- */
- nsISupports readObject(in PRBool aIsStrongRef);
-
- [notxpcom] nsresult readID(out nsID aID);
-
- /**
- * Optimized deserialization support -- see nsIStreamBufferAccess.idl.
- */
- [notxpcom] charPtr getBuffer(in PRUint32 aLength, in PRUint32 aAlignMask);
- [notxpcom] void putBuffer(in charPtr aBuffer, in PRUint32 aLength);
- };
-
- %{C++
-
- inline nsresult
- NS_ReadOptionalObject(nsIObjectInputStream* aStream, PRBool aIsStrongRef,
- nsISupports* *aResult)
- {
- PRBool nonnull;
- nsresult rv = aStream->ReadBoolean(&nonnull);
- if (NS_SUCCEEDED(rv)) {
- if (nonnull)
- rv = aStream->ReadObject(aIsStrongRef, aResult);
- else
- *aResult = nsnull;
- }
- return rv;
- }
-
- %}
-